home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ladder34.zip / LADDERS.DOC < prev    next >
Text File  |  1992-10-16  |  21KB  |  455 lines

  1.  
  2.                              LADDERS   DICE
  3.  
  4.                                   v3.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    LADDERS DICE is a highly challenging, fast-paced, dice game that 
  21.    requires some luck and good strategy. The object of the game is to
  22.    "capture" three ladders by reaching the top of the ladders, based 
  23.    upon the roll of the dice.
  24.  
  25.  
  26.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  27.          created in the directory you run the door from.
  28.  
  29.  
  30.  
  31.                               INSTALLATION
  32.                               ____________
  33.  
  34.  
  35.    Installation is fairly easy and straight-forward. The following steps and
  36.    examples should have you up and running in a very short period of time.
  37.    It is assumed that you are familiar with setting up DOORS on your system.
  38.    To this end, only examples of the configuration file and Door batch file
  39.    are described.
  40.  
  41.       1) Create a directory to hold all LADDERS files
  42.  
  43.       2) Unzip LADDERxx.ZIP into the the above directory
  44.  
  45.          NOTE: BRUN45.EXE is not included but is required !!!
  46.  
  47.       3) Create a configuration file, with a name of your choice, or
  48.          modify the supplied LADDERS.CFG file. A description follows:
  49.  
  50.             **                       Location of system file (See Below)
  51.             SUNRISE-80 BBS           Your BBS Name
  52.             Al                       Sysop's First nameAP
  53.  
  54.             Lawrence                 Sysop's Last Name
  55.  
  56. |-----------------------------------------------------------------------------|
  57. | READ!     1                        CommPort  \ These 2 lines are required   |
  58. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  59. |-----------------------------------------------------------------------------|
  60.  
  61.             00000000                 Registration Number
  62.  
  63.     !   #   2                        Maximum # of Games per day
  64.                                      (Sysop get 99 in Registered verion ONLY!)
  65.  
  66.         #   0                        Max # of days a caller can make up, during
  67.                                      calls in one day. 0=Disable Make-up Option
  68.                                      Maximum value = 27, Minimum value = 1
  69.  
  70.         #   NONE                     Drive:\Path\Filename to contain the
  71.                                      Top Score Bulletin or enter NONE
  72.                                      for NO Bulletin creation.
  73.  
  74.         #   NONE                     Drive:\Path\Filename to contain the
  75.                                      Top Score Bulletin (Color) or enter NONE
  76.                                      for NO Bulletin creation.
  77.  
  78.         #   NONE                     Drive:\Path\Filename to contain the
  79.                                      Hall of Fame Bulletin or enter NONE
  80.                                      for NO Bulletin creation.
  81.  
  82.         #   NONE                     Drive:\Path\Filename to contain the
  83.                                      Hall of Fame Bulletin (Color) or enter NONE
  84.                                      for NO Bulletin creation.
  85.  
  86.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  87.                                      2 = Display ADOPT-A-DOOR message
  88.  
  89.         #   2                        Keyboard timeout value in Minutes
  90.  
  91.         #   3                        # of Ladders to Complete to Accumulate Pts
  92.                                      (Valid range is 1-12. Default = 3)
  93.  
  94.         #   50                   Pts to Deduct if HiScore >   100 & <   500
  95.         #   100                              "            >   499 & <  1000
  96.         #   300                              "            >   999 & <  4999
  97.         #   1000                             "            >  4999 & < 10000
  98.         #   2000                             "            >  9999 & < 20000
  99.         #   3000                             "            > 19999 & < 30000
  100.         #   5000                             "            > 29999 & < 40000
  101.         #   7000                             "            > 39999 & < 50000
  102.         #   9000                             "            > 49999 & < 60000
  103.         #   10000                            "            > 59999 & < 70000
  104.         #   15000                            "            > 69999
  105.    
  106.     !   #   0                        Time Allowed in Door
  107.                                      (Sysop = Time Remaining - REG. VERSION)
  108.  
  109.         #   N                        Automatic game reset at end of month:
  110.                                        Y = Yes enable autoreset
  111.                                        N = Keep accumulating scores
  112.  
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.  
  124.     @   #   XXXX/YYYY                 Blackout Range  From/To
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.  
  130.        ** = Replace with ONE of the following:
  131.  
  132. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  133. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  134. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  135.                                    (Note:DOOR.SYS must be in SAME directory)
  136. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  137. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  138. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  139. c:\bbs\TRIBBS>SYS               <- For TriBBS systems.
  140. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  141. C:\BBS\GTUSER.BBS               <- For GT Power 
  142.                                    * if using this option you must put the
  143.                                      ComPort # on line 5 and the Node # on
  144.                                      line 6 of the configuration file
  145.  
  146.  
  147.               
  148.  
  149.        # = Requires registration to change to a different value.
  150.        ! = See "Plays Per Day" Below
  151.        @ = See "Blackout Periods" Below
  152.  
  153.                NOTE: There are NO Blank Lines in the Config File!!
  154.  
  155.  
  156.       4) Create a batch file or modify the LADDERS file supplied. A
  157.          description of this file follows:
  158.  
  159.             ECHO off
  160.             cd\BBS\DOORS\LADDERS      Location of Ladders files
  161.             LADDERS LADDERS.CFG       EXE filename and CNF filename (Name
  162.                                       used in creating file in #3 above)
  163.             CD\BBS
  164.             BOARD
  165.  
  166.  
  167.        5) When running in more than one node, be sure to supply a
  168.           different configuration name for each node (your choice of name).
  169.  
  170.  
  171.                
  172.                             POOL Points
  173.                             ------------
  174.  
  175. When you end up losing points, LADDERS will place them into a "POOL". This 
  176. "POOL" will continue to accumulate all points lost by any player. It will 
  177. also accumulate the points lost by those playing on any other node(s) at the
  178. same time. The "POOL" points will be updated on the players screen REAL TIME
  179. (at the moment the player on another node loses points). The "POOL" points 
  180. can be won by any player, that wins the game by removing 3 Ladders, 2 of 
  181. which MUST be the "2" and "12" Ladders. The minimum amount in the "POOL" 
  182. will be 100 points.
  183.  
  184.  
  185.                           BLACKOUT PERIODS
  186.                           ________________
  187.  
  188.       Use the Blackout ranges option to define up to 5 time periods during
  189.       which you DO NOT want the Door to be played. If a caller tries to access 
  190.       the Door during the Blackout period, they will be shown a message that
  191.       contains ALL the Blackout periods you have defined, and to try the Door
  192.       at a later time.
  193.  
  194.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  195.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  196.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  197.  
  198.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  199.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  200.                    a Blackout range.
  201.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  202.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  203.        NOTE: The deduction values, above, are the default values. The pgm 
  204.              will check each value to ensure that it is equal to or greater 
  205.              than the prior value. If it fails the check default values will 
  206.              be used. If you do change the default values it will be your 
  207.              reponsibility to edit the LADDERS.INS file and change the 
  208.              deduction table contained within.
  209.  
  210.  
  211.                           PLAYS Per DAY/DOOR Time
  212.                           _______________________
  213.  
  214.       Plays Per Day and Door Time can be controlled several ways:
  215.  
  216.       (1) You can use the Games Per Day, singular option, in the config
  217.           file above. This option, will affect ALL callers whose Security
  218.           Level is NOT defined in any of the 10 optional Security Level/
  219.           Plays Per Day entries in the config file.
  220.  
  221.       (2) You can use the Door Time, singular option, in the config file
  222.           above. This option, will affect ALL callers whose Security
  223.           Level is NOT defined in any of the 10 optional Security Level/
  224.           Plays Per Day/Door Time entries in the config file.
  225.  
  226.       (3) You can restrict the number of games a specific Security Level
  227.           will be allowed to play per day or REWARD specific Levels with 
  228.           more Plays Per Day. 
  229.  
  230.           Likewise, you can restrict the Play time for a specific Security
  231.           Level or REWARD specific Levels with more Door Time.
  232.  
  233.           These options are handled by the use of the 10 config 
  234.           entries (000=00/00). 
  235.           
  236.           The format of each entry is as follows:
  237.  
  238.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  239.                      where =  is a constant and MUST be included
  240.                      where YY is the # of games per day (must be 2 digits)
  241.                      where / is a constant and MUST be included
  242.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  243.           
  244.           If the callers Security Level is NOT defined, his/her Plays Per
  245.           Day and Door Time will be controlled by the values in items
  246.           (1) and (2), above, respectively..
  247.  
  248.           You may define up to 10 Security Levels. All unused entries must
  249.           be defined as   000=00/00
  250.         --------------------------------------------------------------------
  251.           Example: Suppose you had 3 Security Levels defined on your BBS as
  252.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  253.           wanted to set Plays Per Day as :     Subscriber=5
  254.                                            Visiting Sysop=2
  255.                                                   CoSysop=3
  256.                                                    Friend=10 
  257.           
  258.           and Door Time as follows:     Subscriber=30 minutes
  259.                                     Visiting Sysop=20 minutes
  260.                                            CoSysop=10 minutes 
  261.                                             Friend=remaining call time
  262.                                
  263.  
  264.           You would set the Individual "Games per Day" config entry to 1 and 
  265.           the individual "Door Time" to 5 minutes (these would be the 
  266.           default number of games and default Time for all Security Levels
  267.           other than 20,30 or 40... make them any number you want). Next you
  268.           would replace 4 of the Security Level entries as :  020=05/30                                               
  269.                                                               030=02/20
  270.                                                               040=03/10
  271.                                                               090=10/0
  272.  
  273.  
  274.                         NON-STANDARD COM SUPPORT
  275.                         ________________________
  276.  
  277.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  278.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  279.       number after the configuration filename. Let's assume your Door is
  280.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  281.       passed to your Door would be:
  282.  
  283.                             FOOBAR FOOBAR.CFG /5
  284.  
  285.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  286.       normally used with COM1. No /x parameter is needed for the standard
  287.       IRQ's.
  288.  
  289.       As an alternative, you may use an environmental variable on the command
  290.       line. To use the variable (following the example above), place a 
  291.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  292.       different IRQ number for each node). The command line would now look 
  293.       like this: 
  294.  
  295.                           FOOBAR FOOBAR.CFG /%IRQ%
  296.       
  297.       This, in combination with the use of the environmental variables 
  298.       described in the MULTI-NODE SETUP section will allow you to use one 
  299.       batch file and one config file to run this door on all nodes.
  300.  
  301.  
  302.  
  303.  
  304.                            MULTI-NODE SETUP
  305.                            ________________
  306.  
  307.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  308.       ability to access a configuration file which will have its own system 
  309.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  310.       line. There are 2 ways to accomplish this:
  311.  
  312.       (1) Create a separate configuration file for each node. The only 
  313.           difference between each file would be the location of the system 
  314.           file for that particular node. For example, on my system there are 2
  315.           nodes and the first line of the config files would look like this:
  316.  
  317.                         NODE1:  H:\PCB1\DOOR.SYS
  318.                         NODE2:  H:\PCB2\DOOR.SYS
  319.  
  320.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  321.  
  322.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  323.           the following PCBoard environmental variables:
  324.  
  325.                  PCBDIR    (Directory containing the System file)
  326.                  PCBDRIVE  (Drive containing the System file)
  327.  
  328.           Thus, the first line of the SINGLE configuration file, for this Door
  329.           would look like this:
  330.  
  331.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  332.  
  333.       NOTE: This option, as described, assumes that you are running PCBoard 
  334.             14.5a software. The environmental variables are automatically 
  335.             created by the software for each node.
  336.  
  337.             HOWEVER, if you are running other BBS software you should be able
  338.             to set the variables EXACTLY as described below, for EACH node 
  339.             (more than likely in each batch file you use to bring up EACH node):
  340.  
  341.                             PCBDRIVE=C:
  342.                             ^^^^^^^^^
  343.                             PCBDIR=\NODE2
  344.                             ^^^^^^^^
  345.             
  346.             Info with a carat (^) under it, MUST be typed as is. The rest 
  347.             depends on your naming conventions. 
  348.  
  349.             This, in combination with the use of the optional environmental
  350.             variable described in the NON-STANDARD COM SUPPORT section, will
  351.             allow you to use one batch file and one config file to run this 
  352.             door on all nodes.
  353.  
  354.  
  355.  
  356.                                ADOPT-A-DOOR
  357.                                ____________
  358.  
  359.     Having been a Sysop for a number of years, I have had my share of problems
  360.     and frustrations getting financial support for my board's upkeep. A fellow
  361.     Sysop left a message on my board, not long ago, about a concept that was
  362.     being used by several boards around the country.
  363.  
  364.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  365.     would be the same as sending in a donation, only this way it is earmarked
  366.     for registering a particular door. In a way, the user feels he/she is
  367.     "getting something in return". As a Door author I have decided to build
  368.     this concept into each of my Door programs. The concept replaces the
  369.     usual message "tell the Sysop to register this Door" we find in most
  370.     doors.
  371.  
  372.     If the Door is unregisterd then a message appears on the opening screen
  373.     to that effect. After finishing or suspending a game, a message screen
  374.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  375.     caller to contact the Sysop to find out if there is any further details
  376.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  377.     time, etc to callers that ADOPT-A-DOOR.
  378.  
  379.     If the Door has been registered, either by the Sysop or other callers,
  380.     the names of those contributors will be displayed in the closing screen.
  381.  
  382.     NOTE: If you want to display the names of the callers that contributed
  383.           to registering the Door, you must create an ASCII file called
  384.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  385.           the name(s) of the contributors (one on each line, maximum of 5
  386.           entries, each a maximum of 30 characters long). This file must be
  387.           saved, in ASCII format, and placed in the Door directory.
  388.  
  389.  
  390.  
  391.                               LEGALITIES
  392.                               __________
  393.  
  394.  
  395.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  396.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  397.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  398.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  399.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  400.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  401.       OR BREACH OF ANY WARRANTY.
  402.  
  403.  
  404.  
  405.  
  406.  
  407.                              DISTRIBUTION
  408.                              ____________
  409.  
  410.    You may make this file available for downloading from your BBS or you may
  411.    upload it to any BBS of your choice, provided that you do not make any
  412.    changes to the contents of the archive (ZIP file). The archive and its
  413.    individual contents may not be used by any service that charges any money
  414.    whatsoever, without the written permission of the author.
  415.  
  416.  
  417.  
  418.  
  419.  
  420.                              REGISTRATION
  421.                              ____________
  422.  
  423.    Registration and the subsequent insertion of the registration number into
  424.    your configuation file, allows for the display of your BBS name on the
  425.    opening and closing screen as well as the reduction of a delay built into
  426.    the opening screen display along with the ability to change certain
  427.    values in the configuration file.
  428.  
  429.    To register your copy of LADDERS, please fill out the registration form
  430.    (REGISTER.FRM) and mail it along with registration fee to
  431.    the name and address on the form.
  432.  
  433.    Be sure to use the proper upper/lower case when filling in your name and
  434.    BBS name, as they MUST match the way you entered them in the configuration
  435.    file.             ^^^^
  436.  
  437.    Based upon information supplied on the registration form, I will pre-
  438.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  439.    up your registration number.
  440.  
  441.  
  442.  
  443.                                  MISC
  444.                                  ____
  445.  
  446.    The latest version of LADDERS Dice and other fine SUNRISE DOOR programs
  447.    are always available for download from SUNRISE-80 BBS.
  448.  
  449.    Remember, should you have any problems, questions or suggestions, be sure
  450.    to drop me a message on Sunrise-80 or you can reach me through the
  451.    PCRELAY/RIME network in the BBS Doors, Sysops, PCBHints or through a R/O
  452.    to    ->SUNRISE
  453.  
  454.  
  455.